/* -*-c++-*- */
/* osgGIS - GIS Library for OpenSceneGraph
 * Copyright 2007-2008 Glenn Waldron and Pelican Ventures, Inc.
 * http://osggis.org
 *
 * osgGIS is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>
 */

#ifndef _OSGGIS_FEATURE_FILTER_STATE_H_
#define _OSGGIS_FEATURE_FILTER_STATE_H_ 1

#include <osgGIS/Common>
#include <osgGIS/FilterState>
#include <osgGIS/FeatureFilter>

namespace osgGIS
{
    /* (internal class - no public api docs)
     *
     * State object for FeatureFilter implementations. See FilterState for more
     * information on FilterGraph state objects.
     */
    class FeatureFilterState : public FilterState
    {
    public:
        /**
         * Constructs a new state object for the specified Filter.
         *
         * @param filter
         *      FeatureFilter for which to track state
         */
        FeatureFilterState( FeatureFilter* filter );

        /**
         * Pushes a Feature onto the input list.
         */
        void push( Feature* input );

        /**
         * Pushes a list of Features onto the input list.
         */
        void push( const FeatureList& input );

        /**
         * Instructs this state's Filter to process its input.
         *
         * @param env
         *      Runtime processing environment
         */
        FilterStateResult traverse( FilterEnv* env );

    protected:
        FeatureList in_features;
        osg::ref_ptr<FeatureFilter> filter;
    };
}

#endif // _OSGGIS_FEATURE_FILTER_STATE_H_
